feat: enhance pre-commit configuration with comprehensive hooks#101
Merged
feat: enhance pre-commit configuration with comprehensive hooks#101
Conversation
- Add comprehensive pre-commit hooks for better code quality - trailing-whitespace: Remove trailing whitespace - end-of-file-fixer: Ensure files end with newline - check-added-large-files: Prevent large files from being committed - check-json: Validate JSON files - check-toml: Validate TOML files - debug-statements: Check for debugger imports - mixed-line-ending: Normalize line endings - isort: Sort imports with black-compatible profile - ruff: Fast Python linter with auto-fix capabilities - Update .gitignore to exclude CLAUDE.md (AI assistant configuration file) - Maintain existing black formatter configuration
- Create DEVELOPMENT.md with detailed setup instructions - Add uv installation guide for all platforms - Document all pre-commit hooks and their purposes - Include troubleshooting section for common issues - Update README.md to reference the new development guide - Provide clear workflow instructions for testing and formatting
AndyBoWu
requested review from
bonnie57,
edisonz0718,
limengformal,
lucas2brh and
sebsadface
as code owners
- Update black from 23.12.1 to 25.1.0 - Update pre-commit-hooks from v4.5.0 to v5.0.0 - Update ruff from v0.1.9 to v0.8.4 - Keep isort at 5.13.2 (latest stable version)
- Add venv/, env/, ENV/, .venv/, virtualenv/ to .gitignore - Prevents accidentally committing virtual environment files - Virtual environments should always be created locally - Reduces repository size and avoids platform-specific issues
bonnie57
approved these changes
Aug 4, 2025
Contributor
bonnie57
left a comment
bonnie57
left a comment
There was a problem hiding this comment.
It's a very comprehensive hook! 👍
Could you please remove the Running test cases and Formatting sections from the README.md file? I think it's a little repetitive.
Besides, I followed up on the guide and found some issues via the new pre-commit rules. I have created another pr Please help me review it.
lucas2brh
approved these changes
Aug 4, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Notes